/**
 * Copyright (C) 2008 GeoScheduler Team, as stated on <http://www.geoscheduler.org/authors>.
 * 
 * This file is part of GeoScheduler.
 * 
 * GeoScheduler is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * GeoScheduler is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with GeoScheduler. If not, see <http://www.gnu.org/licenses/>.
 */

package org.geoscheduler.commons.i18n;

import java.util.Locale;

/**
 * 
 * <h2>LocalizationSource</h2>
 * <p>
 * Interface providing contract for sources of localization for particular type
 * or operation.
 * </p>
 * <p>
 * Method of translating source key and locale to localized value depends on
 * actual implementation.
 * </p>
 * <p>
 * Translation implementation must support formating parameters as described in
 * JDK MessageFormat documentation.
 * </p>
 * 
 * @author LKo (Lukas.Kolisko@Geoscheduler.Org)
 */
public interface LocalizationSource {

	public static LocalizationSource VOID_LOC_SOURCE = new LocalizationSource() {

		public String translate(String key, String defValue, Locale locale, Object... params) {
			return key;
		}

		public String translate(String key, Locale locale, Object... params) {
			return key;
		}
	};

	/**
	 * Translate message key to localized message.
	 * 
	 * @param key
	 *            key of message
	 * @param defValue
	 *            default value when no localization found
	 * @param locale
	 * @param params
	 * @return localized message String
	 */
	String translate(String key, String defValue, Locale locale, Object... params);

	/**
	 * Translate key to corresponding localized message. Representation of value
	 * when no localization for particular key found depends on implementation.
	 * 
	 * @see #translate(String, String, Locale, Object...)
	 */
	String translate(String key, Locale locale, Object... params);

}
